SureTax Returns API
GET Form Instance Generation Log
Overview
This API endpoint retrieves the generation log associated with a specific form instance. It allows clients to access detailed information about the process of generating the form, including any messages, warnings, or errors encountered during the generation process. This information can be valuable for troubleshooting, auditing, and ensuring the accuracy of generated forms.
OperationId: GET Form Instance Generation Log
Authorization Method(s): OAuth
Verb: GET
End Point: /api/v1/Forms/FormInstanceGenerationLog
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Id* | Id | string |
Overview
Response object for form instance log.
Example Response
The following is an example response you can expect for this operation
{
"data": [
{
"log": [
{
"messageType": "E",
"message": "Invalid value at \u0027Tax Payer ID\u0027: \u0027123456789\u0027. Value must be 8 digits.",
"elementId": "1",
"elementName": "Tax Payer ID",
"attributeId": "1",
"attributeName": "ABC"
}
]
}
]
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The API response contains the status for a deletion process. Success Response - 200 OK. The API will respond with the current status of the process. |
| 204 | 204 No Content If no records are found for the provided request, the API will respond with a No Content status. |
| 400 | Bad Request - The server could not process the request due to invalid input or missing required parameters. |
| 401 | 401 Unauthorized: The user's authentication is not valid. |
| 500 | Internal Server Error - An unexpected error occurred on the server while processing the request. |